Add WebviewBuilder::limit_navigations_to_app_bound_domains - #13848

@FabianLars sorry I just got to rebasing, this should be good to merge in. LMK if there's any changes I should make.

no worries and thanks for the PR :)

Package Changes Through ce6dafb

There are 14 changes which include tauri with minor, tauri-cli with minor, @tauri-apps/cli with minor, tauri-runtime with minor, tauri-runtime-wry with minor, tauri-utils with minor, tauri-bundler with minor, tauri-build with minor, tauri-macos-sign with minor, tauri-codegen with minor, tauri-macros with minor, tauri-plugin with minor, tauri-driver with minor, @tauri-apps/api with minor

Add another change file through the GitHub UI by following this link.

Read about change files or the docs at github.com/jbolda/covector

@FabianLars are there any further changes you'd like me to make before this gets merged in?

do you think this should be configurable in tauri.conf.json as well?

do you think this should be configurable in tauri.conf.json as well?

Sure! I wired this up.

@Legend-Master just checking in since I saw you added the 2.12 label recently. Should I rebase my changes again?

Yes, I personally prefer a merge so we don't lose the review history from a rebase + force push, but do whatever you prefer

Yes, I personally prefer a merge so we don't lose the review history from a rebase + force push, but do whatever you prefer

done!

Apart from the missing ,, looks like this is also available on macOS right?

https://developer.apple.com/documentation/webkit/wkwebviewconfiguration/limitsnavigationstoappbounddomains

Apart from the missing ,, looks like this is also available on macOS right?

https://developer.apple.com/documentation/webkit/wkwebviewconfiguration/limitsnavigationstoappbounddomains

It seems that limitAppBoundDomains can be set in MacOS as well but based on searching through the WebKit source code, the sole WebKit issue mentioning limitAppBoundDomains and MacOS (https://bugs.webkit.org/show_bug.cgi?id=216628), and the blog post on App-Bound Domains the flag doesn't change any behavior on MacOS; in fact the internal getter for whether it is set is gated behind a #if PLATFORM(IOS_FAMILY) flag [source code]. I also just messaged the WebKit #help slack channel and am waiting for a response.

If we do want to have it set the flag on MacOS as well then I'd have to go back and edit Wry as well and I think it's unnecessary to have it do anything on MacOS because the flag only seems to be checked on iOS.

Thanks for the detailed digging! We can merge this first and if it ever gets supported on macOS in the future we can always add that then.

When re-reading the doc comment while making the above fixes I realized I forgot to implement this:

Assets served through custom protocols like Tauri's IPC are added to the list automatically.

Because we don't know what domains people use for their custom protocols at build time (e.g. custom://domain1, custom://domain2, etc.), I'll change the comment to be:

Assets served through custom protocols configured by Tauri (tauri://localhost, ipc://localhost, and 
isolation-{uuid}://localhost) are added to the WKAppBoundDomains list automatically. Domains on 
protocols defined via 
[`register_asynchronous_uri_scheme_protocol`](tauri::Builder::register_asynchronous_uri_scheme_protocol) 
or [`register_uri_scheme_protocol`](tauri::Builder::register_uri_scheme_protocol) are not added 
automatically. If you use a custom protocol, be sure to list all domains you use on such protocols 
in the Info.plist file.

I'll try to get the automatic Info.plist additions implemented today. I also just pushed the nits from your review.

After inspecting the WebKit source code, I found that the ENABLE_APP_BOUND_DOMAINS is only set to true if PLATFORM(IOS_FAMILY):
https://github.com/WebKit/WebKit/blob/1029c99e92ffa6735a57c79f0d436702f27e0e38/Source/WTF/wtf/PlatformEnableCocoa.h#L83-L85

It also seems that simply adding localhost to the WKAppBoundDomains Info.plist field will automatically allow any protocol's localhost domain based on reading through the source code. See:
https://github.com/WebKit/WebKit/blob/898be46c29af657b82dab5b773edffa86e31715e/Source/WebKit/UIProcess/WebsiteData/Cocoa/WebsiteDataStoreCocoa.mm#L685-L694

and:

https://github.com/WebKit/WebKit/blob/898be46c29af657b82dab5b773edffa86e31715e/Source/WebCore/platform/RegistrableDomain.h#L43-L46

that uses:

https://github.com/WebKit/WebKit/blob/898be46c29af657b82dab5b773edffa86e31715e/Source/WebCore/platform/RegistrableDomain.h#L118-L124

Note that "https" is added just to immediately be stripped for actually constructing the list of domains that are app-bound. Also see the following for where schemes and domains are checked for app-boundedness. Note especially that either the protocol must be app-bound or the domain must be app-bound.

https://github.com/WebKit/WebKit/blob/898be46c29af657b82dab5b773edffa86e31715e/Source/WebKit/UIProcess/WebsiteData/Cocoa/WebsiteDataStoreCocoa.mm#L732-L737

So I will just add localhost by default to the WKAppBoundDomains Info.plist field if limitNavigationsToAppBoundDomains is set in the tauri config.

@Legend-Master Sorry I forgot to add the automatic addition of localhost to the Info.plist file if limitNavigationsToAppBoundDomains is set in the tauri.config.json file. Now I believe this PR should be good to go.

@FabianLars @Legend-Master I've reverted the automatic addition of WKAppBoundDomains and updated the documentation accordingly. Hopefully this PR is finally good to go 😅